EEPROM 17 Click Driver

API for configuring and manipulating EEPROM 17 Click driver. More...

Topics
	EEPROM 17 Registers List
	List of registers of EEPROM 17 Click driver.
	EEPROM 17 Registers Settings
	EEPROM 17 description register.
	EEPROM 17 MikroBUS Map
	MikroBUS pin mapping of EEPROM 17 Click driver.

Functions
void	eeprom17_cfg_setup (eeprom17_cfg_t *cfg)
	EEPROM 17 configuration object setup function.
err_t	eeprom17_init (eeprom17_t *ctx, eeprom17_cfg_t *cfg)
	EEPROM 17 initialization function.
err_t	eeprom17_write_memory (eeprom17_t *ctx, uint8_t address, uint8_t *data_in, uint8_t len)
	EEPROM 17 Write Memory function.
err_t	eeprom17_read_memory (eeprom17_t *ctx, uint8_t address, uint8_t *data_out, uint16_t len)
	EEPROM 17 Read Memory function.
void	eeprom17_set_wc_pin (eeprom17_t *ctx, uint8_t state)
	EEPROM 17 Set Write Control Pin function.
err_t	eeprom17_select_bank (eeprom17_t *ctx, uint8_t bank_sel)
	EEPROM 17 Select Memory Bank function.

Detailed Description

API for configuring and manipulating EEPROM 17 Click driver.

Any initialization code needed for MCU to function properly. Do not remove this line or clock might not be set correctly.

Function Documentation

eeprom17_cfg_setup()

void eeprom17_cfg_setup

(

eeprom17_cfg_t *

cfg

)

EEPROM 17 configuration object setup function.

This function initializes Click configuration structure to initial values.

Parameters

[out]

cfg

: Click configuration structure. See eeprom17_cfg_t object definition for detailed explanation.

Returns

Nothing.

Note

The all used pins will be set to unconnected state.

eeprom17_init()

err_t eeprom17_init	(	eeprom17_t *	ctx,
		eeprom17_cfg_t *	cfg )

EEPROM 17 initialization function.

This function initializes all necessary pins and peripherals used for this Click board.

Parameters

[out]	ctx	: Click context object. See eeprom17_t object definition for detailed explanation.
[in]	cfg	: Click configuration structure. See eeprom17_cfg_t object definition for detailed explanation.

Returns

• 0 - Success,
• -1 - Error. See #err_t definition for detailed explanation.

Note

None.

eeprom17_read_memory()

err_t eeprom17_read_memory	(	eeprom17_t *	ctx,
		uint8_t	address,
		uint8_t *	data_out,
		uint16_t	len )

EEPROM 17 Read Memory function.

This function reads data from the EEPROM memory starting from the specified address.

Parameters

[in]	ctx	: Click context object. See eeprom17_t object definition for detailed explanation.
[in]	address	: Start address in EEPROM memory.
[out]	data_out	: Pointer to the buffer to store read data.
[in]	len	: Number of bytes to read (up to 256).

Returns

• 0 - Success,
• -1 - Error.

Note

None.

eeprom17_select_bank()

err_t eeprom17_select_bank	(	eeprom17_t *	ctx,
		uint8_t	bank_sel )

EEPROM 17 Select Memory Bank function.

This function selects the active memory bank in the EEPROM.

Parameters

[in]	ctx	: Click context object. See eeprom17_t object definition for detailed explanation.
[in]	bank_sel	: Memory bank selection (0 or 1).

Returns

• 0 - Success,
• -1 - Error.

Note

None.

eeprom17_set_wc_pin()

void eeprom17_set_wc_pin	(	eeprom17_t *	ctx,
		uint8_t	state )

EEPROM 17 Set Write Control Pin function.

This function sets the state of the write control (WC) pin.

Parameters

[in]	ctx	: Click context object. See eeprom17_t object definition for detailed explanation.
[in]	state	: Pin state (0 - LOW, 1 - HIGH).

Note

Write Control/Disable pin is active high.

eeprom17_write_memory()

err_t eeprom17_write_memory	(	eeprom17_t *	ctx,
		uint8_t	address,
		uint8_t *	data_in,
		uint8_t	len )

EEPROM 17 Write Memory function.

This function writes data to the EEPROM memory starting from the specified address.

Parameters

[in]	ctx	: Click context object. See eeprom17_t object definition for detailed explanation.
[in]	address	: Start address in EEPROM memory.
[in]	data_in	: Pointer to the data to be written.
[in]	len	: Number of bytes to write (up to 16).

Returns

• 0 - Success,
• -1 - Error.

Note

None.